home *** CD-ROM | disk | FTP | other *** search
/ Carousel Volume 2 #1 / carousel.iso / mactosh / lang / help_com.hqx / Help Compiler.pit / Compiler.HT next >
Encoding:
Text File  |  1988-06-04  |  2.9 KB  |  92 lines
  1. %% cream 10
  2. Welcome to the Help Compiler v1.0 help facility.
  3. Select a subject╔
  4. % Purpose
  5.     The \bHelp Compiler\e is a development tool, which
  6. is designed to aid in the construction of help dialogs
  7. like this one. You write the help text, and the program
  8. writes the resources. Then, when your program is 
  9. running, you call the provided code resource, which
  10. reads in the resources, and shows the help messages.
  11. % Usage
  12. In order to use the \bHelp Compiler\e, follow these
  13. steps:
  14.  
  15. Ñ    Prepare an input specification, as described in the
  16. \bFormats\e description below.
  17.  
  18. Ñ    Compile it, using the \bcompile\e menu option.
  19. This will automatically show it to you when it is done.
  20. You must save the resources in your application file.
  21. Prior help resources will be deleted, but all others will
  22. be left intact.
  23.  
  24. Ñ    Refine the help specification until it looks right to
  25. you.
  26.  
  27. Ñ    Call \b\iShowHelp()\e from your application when
  28. you want to display help info. The \b\iShowHelp()\e which
  29. is supplied is in the \bC\e language. You will have to 
  30. rewrite it for other languages.
  31.  
  32. Ñ    When you want to change the help specification,
  33. you can use the \bDecompile\e option in the \b\oOperations\e
  34. menu. This option will generate a help text file from an
  35. existing set of help resources.
  36.  
  37. % Formats
  38.     The input format of the help compiler is simple.
  39. There is a heading, and as many catagories as you
  40. choose to enter. 
  41.     The heading begins with \u%%\e, and optionally
  42. contains both the font and font size which will be
  43. used to display the help text. Note that if either the
  44. font or the size are not available at run time, the
  45. system will default both.
  46.     After the header section comes the help catagory
  47. sections. These begin with a single \u%\e, followed
  48. by the name of the help catagory. The following lines 
  49. contain the text which will be displayed when the
  50. user selects this catagory. This text is terminated
  51. either by the start of another catagory, or by the end
  52. of the input file. 
  53.     In the text, you can specify that words or phrases 
  54. are emphasized (\ilike some of the\e \iwords in this
  55. text\e) by surrounding them by escape sequences. The
  56. following sequences are recognized:
  57.  
  58.     Ñ \b\\b        Bold\e
  59.     Ñ \c\\c        Condense\e
  60.     Ñ \x\\x        Extend\e
  61.     Ñ \o\\o        Outline\e
  62.     Ñ \i\\i        Italic\e
  63.     Ñ \s\\s    Shadow\e
  64.     Ñ \\e        Terminate Escape
  65.     Ñ \\\\    Show a single \b\\\e
  66.  
  67. You can make combinations of these by just using
  68. both before the emphasized text. For example, to get
  69. \b\iBold and Italic\e, type
  70.     \\b\\iBold and Italic\\e.
  71.     If you choose a font which is not one of the 
  72. required fonts, be sure to include it in the application
  73. file.
  74. % Examples
  75. This section gives an example of the types of things
  76. you might do in your help specification. The
  77. distribution includes the help text for this program in 
  78. \bCompiler.HT\e.
  79.  
  80. \%% monaco 9
  81. This is the introduction.
  82. \% Section 1
  83. \\bThis section is bold.
  84. It continues for 4 lines.
  85. 3
  86. 4\\e
  87. \% Section 2
  88. \\xThis sentence is in extended text.\\e
  89. This sentence is not
  90. \% Section 3
  91. This is the last section.
  92.